<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja" id="main">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>Window Class</title>
	<link rel="stylesheet" href="../inc/css/style.min.css" />
	<script type="text/javascript" src="../inc/js/lib/jquery-1.11.1.min.js"></script>
	<script type="text/javascript" src="../inc/js/common.js"></script>
</head>
<body>

	<div class="main">

		<h1 class="main__title--h1 main__title--h1--v07">Window Class</h1>
		<ul class="breadcrumb">
			<li>JSライブラリ</li>
			<li>&gt;</li>
			<li>Window Class</li>
		</ul>
		<p>The window in the game.</p>
		<div class="main__section">
			<h2 class="main__title--h2">Constructor</h2>
<pre class="main__pre--code">
Window ()
</pre>
		</div><!-- /main__section -->


		<div class="main__section">
			<h2 class="main__title--h2">Item Index</h2>
			<b>Methods</b>
			<ul class="main__ul--inline">
				<li><a href="#m01">addChild</a></li>
				<li><a href="#m02">addChildAt</a></li>
				<li><a href="#m03">addChildToBack</a></li>
				<li><a href="#m04">isClosed</a></li>
				<li><a href="#m05">isOpen</a></li>
				<li><a href="#m06">move</a></li>
				<li><a href="#m07">removeChild</a></li>
				<li><a href="#m08">removeChildAt</a></li>
				<li><a href="#m09">setCursorRect</a></li>
				<li><a href="#m10">setTone</a></li>
				<li><a href="#m11">update</a></li>
			</ul>

			<b>Properties</b>
			<ul class="main__ul--inline">
				<li><a href="#p01">active</a></li>
				<li><a href="#p02">backOpacity</a></li>
				<li><a href="#p03">children</a></li>
				<li><a href="#p04">contents</a></li>
				<li><a href="#p05">contentsOpacity</a></li>
				<li><a href="#p06">downArrowVisible</a></li>
				<li><a href="#p07">height</a></li>
				<li><a href="#p08">margin</a></li>
				<li><a href="#p09">opacity</a></li>
				<li><a href="#p10">openness</a></li>
				<li><a href="#p11">origin</a></li>
				<li><a href="#p12">padding</a></li>
				<li><a href="#p13">parent</a></li>
				<li><a href="#p14">pause</a></li>
				<li><a href="#p15">upArrowVisible</a></li>
				<li><a href="#p16">visible</a></li>
				<li><a href="#p17">width</a></li>
				<li><a href="#p18">windowskin</a></li>
				<li><a href="#p19">x</a></li>
				<li><a href="#p20">y</a></li>
			</ul>
		</div><!-- /main__section -->


		<div class="main__section">
			<h2 class="main__title--h2">Methods</h2>

			<div id="m01" class="main__subsection">
<pre class="main__pre--code">
addChild ( child ) <span class="pre__type">Object</span>
</pre>
				<p class="mb10px">Adds a child to the container.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">child</code>
							<span class="type">Object</span>
							<div class="param-description">
								<p>The child to add</p>
							</div>
						</li>
					</ul>
					<h4>Returns:</h4>
					<p><span class="pre__type">Object:</span> <br />
					The child that was added</p>
				</div>
			</div><!-- /div -->

			<div id="m02" class="main__subsection">
<pre class="main__pre--code">
addChildAt ( child  index ) <span class="pre__type">Object</span>
</pre>
				<p class="mb10px">Adds a child to the container.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">child</code>
							<span class="type">Object</span>
							<div class="param-description">
								<p>The child to add</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">index</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The index to place the child in</p>
							</div>
						</li>
					</ul>
					<h4>Returns:</h4>
					<p><span class="pre__type">Object:</span> <br />
					The child that was added</p>
				</div>
			</div><!-- /div -->

			<div id="m03" class="main__subsection">
<pre class="main__pre--code">
addChildToBack ( child ) <span class="pre__type">Object</span>
</pre>
				<p class="mb10px">Adds a child between the background and contents.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">child</code>
							<span class="type">Object</span>
							<div class="param-description">
								<p>The child to add</p>
							</div>
						</li>
					</ul>
					<h4>Returns:</h4>
					<p><span class="pre__type">Object:</span> <br />
					The child that was added</p>
				</div>
			</div><!-- /div -->

			<div id="m04" class="main__subsection">
<pre class="main__pre--code">
isClosed ()
</pre>
				<p class="mb10px">Returns true if the window is completely closed (openness == 0).</p>
			</div><!-- /div -->

			<div id="m05" class="main__subsection">
<pre class="main__pre--code">
isOpen ()
</pre>
				<p class="mb10px">Returns true if the window is completely open (openness == 255).</p>
			</div><!-- /div -->

			<div id="m06" class="main__subsection">
<pre class="main__pre--code">
move ( x , y , width , height )
</pre>
				<p class="mb10px">Sets the x, y, width, and height all at once.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">x</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The x coordinate of the window</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">y</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The y coordinate of the window</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">width</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The width of the window</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">height</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The height of the window</p>
							</div>
						</li>
					</ul>
				</div>
			</div><!-- /div -->

			<div id="m07" class="main__subsection">
<pre class="main__pre--code">
removeChild ( child ) <span class="pre__type">Object</span>
</pre>
				<p class="mb10px">Removes a child from the container.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">child</code>
							<span class="type">Object</span>
							<div class="param-description">
								<p>The child to remove</p>
							</div>
						</li>
					</ul>
					<h4>Returns:</h4>
					<p><span class="pre__type">Object:</span> <br />
					The child that was removed</p>
				</div>
			</div><!-- /div -->

			<div id="m08" class="main__subsection">
<pre class="main__pre--code">
removeChildAt ( index ) <span class="pre__type">Object</span>
</pre>
				<p class="mb10px">Removes a child from the specified index position.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">index</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The index to get the child from</p>
							</div>
						</li>
					</ul>
					<h4>Returns:</h4>
					<p><span class="pre__type">Object:</span> <br />
					The child that was removed</p>
				</div>
			</div><!-- /div -->

			<div id="m09" class="main__subsection">
<pre class="main__pre--code">
setCursorRect ( x , y , width , height )
</pre>
				<p class="mb10px">Sets the position of the command cursor.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">x</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The x coordinate of the cursor</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">y</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The y coordinate of the cursor</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">width</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The width of the cursor</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">height</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The height of the cursor</p>
							</div>
						</li>
					</ul>
				</div>
			</div><!-- /div -->

			<div id="m10" class="main__subsection">
<pre class="main__pre--code">
setTone ( r , g , b )
</pre>
				<p class="mb10px">Changes the color of the background.</p>
				<div class="params">
					<h4>Parameters:</h4>
					<ul class="params-list">
						<li class="param">
							<code class="param-name">r</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The red value in the range (-255, 255)</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">g</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The green value in the range (-255, 255)</p>
							</div>
						</li>
						<li class="param">
							<code class="param-name">b</code>
							<span class="type">Number</span>
							<div class="param-description">
								<p>The blue value in the range (-255, 255)</p>
							</div>
						</li>
					</ul>
					<h4>Returns:</h4>
					<p><span class="pre__type"></span><br />

					</p>
				</div>
			</div><!-- /div -->

			<div id="m11" class="main__subsection">
<pre class="main__pre--code">
update ()
</pre>
				<p class="mb10px">Updates the window for each frame.</p>
			</div><!-- /div -->

		</div><!-- /main__section -->


		<div class="main__section">
			<h2 class="main__title--h2">Properties</h2>

			<div id="p01" class="main__subsection">
<pre class="main__pre--code">
active <span class="pre__type">Boolean</span>
</pre>
				<p class="mb10px">The active state for the window.</p>
			</div><!-- /div -->

			<div id="p02" class="main__subsection">
<pre class="main__pre--code">
backOpacity <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The opacity of the window contents (0 to 255).</p>
			</div><!-- /div -->

			<div id="p03" class="main__subsection">
<pre class="main__pre--code">
children <span class="pre__type">Array</span>
</pre>
				<p class="mb10px">[read-only] The array of children of the window.</p>
			</div><!-- /div -->

			<div id="p04" class="main__subsection">
<pre class="main__pre--code">
contents <span class="pre__type"><a href="01_01.html">Bitmap</a></span>
</pre>
				<p class="mb10px"></p>
			</div><!-- /div -->

			<div id="p05" class="main__subsection">
<pre class="main__pre--code">
contentsOpacity <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The opacity of the window contents (0 to 255).</p>
			</div><!-- /div -->

			<div id="p06" class="main__subsection">
<pre class="main__pre--code">
downArrowVisible  <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The opacity of the window contents (0 to 255).</p>
			</div><!-- /div -->

			<div id="p07" class="main__subsection">
<pre class="main__pre--code">
height <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The height of the window in pixels.</p>
			</div><!-- /div -->

			<div id="p08" class="main__subsection">
<pre class="main__pre--code">
margin <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The size of the margin for the window background.</p>
			</div><!-- /div -->

			<div id="p09" class="main__subsection">
<pre class="main__pre--code">
opacity <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The opacity of the window without contents (0 to 255).</p>
			</div><!-- /div -->

			<div id="p10" class="main__subsection">
<pre class="main__pre--code">
openness <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The openness of the window (0 to 255).</p>
			</div><!-- /div -->

			<div id="p11" class="main__subsection">
<pre class="main__pre--code">
origin <span class="pre__type">Point</span>
</pre>
				<p class="mb10px">The origin point of the window for scrolling.</p>
			</div><!-- /div -->

			<div id="p12" class="main__subsection">
<pre class="main__pre--code">
padding <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The size of the padding between the frame and contents.</p>
			</div><!-- /div -->

			<div id="p13" class="main__subsection">
<pre class="main__pre--code">
parent <span class="pre__type">Object</span>
</pre>
				<p class="mb10px">[read-only] The object that contains the window.</p>
			</div><!-- /div -->

			<div id="p14" class="main__subsection">
<pre class="main__pre--code">
pause <span class="pre__type">Boolean</span>
</pre>
				<p class="mb10px">The visibility of the pause sign.</p>
			</div><!-- /div -->

			<div id="p15" class="main__subsection">
<pre class="main__pre--code">
upArrowVisible <span class="pre__type">Boolean</span>
</pre>
				<p class="mb10px">The visibility of the up scroll arrow.</p>
			</div><!-- /div -->

			<div id="p16" class="main__subsection">
<pre class="main__pre--code">
visible <span class="pre__type">Boolean</span>
</pre>
				<p class="mb10px">The visibility of the window.</p>
			</div><!-- /div -->

			<div id="p17" class="main__subsection">
<pre class="main__pre--code">
width <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The width of the window in pixels.</p>
			</div><!-- /div -->

			<div id="p18" class="main__subsection">
<pre class="main__pre--code">
windowskin <span class="pre__type"><a href="01_01.html">Bitmap</a></span>
</pre>
				<p class="mb10px">The image used as a window skin.</p>
			</div><!-- /div -->

			<div id="p19" class="main__subsection">
<pre class="main__pre--code">
x <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The x coordinate of the window.</p>
			</div><!-- /div -->

			<div id="p20" class="main__subsection">
<pre class="main__pre--code">
y <span class="pre__type">Number</span>
</pre>
				<p class="mb10px">The y coordinate of the window.</p>
			</div><!-- /div -->


		</div><!-- /main__section -->


	</div><!-- /main -->

</body>
</html>